Feat/copy assets

[joshuaunity]

Description

This PR introduces an API allowing users to copy assets from one account to another, using the original account's assets as templates. The feature is currently in progress and being developed incrementally.

##TODO

• Successfully Copy Assets to target account
• Write a test to confirm the above feature
• Write a test to confirm that asset parents and children are accurate
• Successfully copy assets and asset sensors to the target account
• Write a test to confirm the above feature
• Successfully copy asset flexconfig... (i dont know how feasible this would be yet, mayb e 80% ?)
• Write a test to confirm the above feature

Look & Feel

None

How to test

Further Improvements

Related Items

This PR closes #1966

Sign-off

• I agree to contribute to the project under Apache 2 License.
• To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

[joshuaunity]

CC @nhoening

[read-the-docs-community]

Documentation build overview

📚 flexmeasures | 🛠️ Build #31796443 | 📁 Comparing fb39eac against latest (c6bb60f)

🔍 Preview build

Show files changed (4 files in total): 📝 4 modified | ➕ 0 added | ➖ 0 deleted

File	Status
genindex.html	📝 modified
_autosummary/flexmeasures.api.common.utils.api_utils.html	📝 modified
_autosummary/flexmeasures.api.v3_0.assets.html	📝 modified
api/v3_0.html	📝 modified

[Flix6x]

Thank you for requesting a review. It looks like the scope of this PR may be mistaken? You are creating an endpoint to copy all assets under a given account*, rather than an endpoint to copy a given asset, including all assets under it.

[nhoening]

We can also discuss the test strategy. Joshua chose to implement a part of the solution, then tests for that, then the next part, test for that etc.

I believe we suggested initially to have one test case that tests a complete successful copy, then work on making it pass.

• The test can assert the first part first (e.g. assets and subassets are copied), and others later(sensors, flex-config are copied), so you can still follow along how far you are in kaking the test pass, layer by layer.
• This way would be more helpful in understanding together if the scope is agreed between all of us. The test is easier to write (I suggest using AI to help) and to read than the actual implementation.

[Flix6x]

This is a mistake.

[Flix6x]

I'd expect the API endpoint to live under "/api/v3_0/assets/<id>/copy".

[Flix6x]

• Please move these to a new class CopyAssetSchema(ma.Schema).
• I'd propose two arguments for the "/api/v3_0/assets/<id>/copy" endpoint:
  • account_id = AccountIdField(data_key="account", required=False) # defaults to the account of the asset whose ID is part of the endpoint
  • parent_id = AssetIdField(data_key="parent", required=Flase) # defaults to the parent of the asset whose ID is part of the endpoint
• The schema should also (@post_load):
  • If an account is explicitly given and no parent is explicitly given, then set parent to None, so it becomes a top-level asset (i.e. no parent) in the explicitly stated account
  • If a parent is explicitly stated and no account is explicitly given, then set the account to the account of the parent, so that the copied asset belongs to the same account as the parent.
  • Document that, if an account and parent are both explicitly stated, this makes it possible to create a copied asset that belongs to a different account than its parent. This is fine.
• Finally, the endpoint should check for create-children permissions using both the account and parent as context.

[joshuaunity]

I think I may have gotten this wrong, the current function actually copies over everything (asset) in the account, but from your feedback, it Is suppose to only cover a single asset(and its children along with sensors) that was specified

[joshuaunity]

I'm a bit confused. Why do we need to specify an account and a parent?

We can get this info from the asset we want to copy by asset.parent_asset_id.

If we are going to pass the asset ID in the URL, why are we not just copying that specified ID? As you said, with those two parameters, I can specify things outside the account.

I imagine the copy button on the UI will be in each asset detail page. When it is clicked on, a modal may pop up in which you need to select a target account to copy to.

[nhoening]

I also don't understand why these two are required.

[Flix6x]

Suppose I have in a client's account two assets both with no parent representing two houses A and B. House A has a child asset representing an EV charger. I also have a house under my own account, house C. Here are some use cases:

1. Extra charger on house A

Copy charger asset with default account and parent. The new charger lives under house A next to the existing charger.

2. Same charger on house B

Copy charger asset with parent set to house B. The new charger lives under house B, and belongs to the same account.

3. Copy charger to my account

Copy charger asset with account set to my account. The new charger lives under my account, without a parent.

4. Copy charger to my house C

Parent asset is set to house C. Account defaults to the account of house C. New charger lives under house C and belongs to my account.

[joshuaunity]

I see, i think i get it now

[joshuaunity]

ive made updates to this, what do you think @Flix6x