Creating & Re-Creating Project

[c-heat16]

If we create a project in a python script, and at the end of the script call api.delete(project) should we be able to run the script again afterwards?

Seems like the answer should be yes, but I am encountering different behavior. The script below will create a project, collection, and material and then delete the project at the end with a call to api.delete(project) and gives a message that the project has been deleted. However, trying to run the script again gives a message that a project with the same name already exists.

Message for successful delete after first run: INFO: Deleted 'Project' with UUID of 'd100a7d0-60c5-4306-9a9b-aec98b0a5c0b' from CRIPT API.

Trace on subsequent run:

Traceback (most recent call last):
  File "/Users/czh/projects/cript_sandbox/scratch_10032023.py", line 48, in <module>
    api.save(project)
  File "/Users/czh/projects/cript_gui_upload_tool/cript_venv/lib/python3.11/site-packages/cript/api/api.py", line 704, in save
    raise exc from exc
  File "/Users/czh/projects/cript_gui_upload_tool/cript_venv/lib/python3.11/site-packages/cript/api/api.py", line 698, in save
    self._internal_save(project)
  File "/Users/czh/projects/cript_gui_upload_tool/cript_venv/lib/python3.11/site-packages/cript/api/api.py", line 771, in _internal_save
    raise CRIPTDuplicateNameError(response, json_data, exc) from exc
cript.api.exceptions.CRIPTDuplicateNameError: The name 'Project Test Shared Materials 123456' for your Project node is already present in CRIPT. Either choose a new name!

Code:

import os
import json
import cript

def make_fetch_node(
        api, node_name, node_type=cript.Project, search_mode=cript.SearchModes.EXACT_NAME,
        verbosity=1,
        **kwargs
):
    if verbosity >= 1:
        fancy_print('* searching for {} *'.format(node_name))
    res_paginator = api.search(
        node_type=node_type,
        search_mode=search_mode,
        value_to_search=node_name
    )

    try:
        print('* selecting first result on first page *')
        to_return = res_paginator.current_page_results[0]
        if verbosity >= 1:
            fancy_print('* loading existing {} from json *'.format(node_name))
        # print('to_return:\n{}'.format(json.dumps(to_return, indent=2)))
        if node_type == cript.Material and to_return.get('project', None) is not None:
            print('* deleting project item from node json *')
            del to_return['project']

        to_return = cript.load_nodes_from_json(json.dumps(to_return))
        if verbosity >= 1:
            fancy_print('* existing {} node retrieved *'.format(node_name))
        return to_return

    except Exception:
        if verbosity >= 1:
            fancy_print('* creating {} node *'.format(node_name))

        if node_type != cript.Reference:
            kwargs['name'] = node_name
        if node_type not in [cript.Project, cript.Collection, cript.Inventory, cript.Reference, cript.Experiment]:
            identifier = kwargs.get('identifier', [])
            identifier.append({'names': [node_name]})
            kwargs['identifier'] = identifier
        return node_type(**kwargs)

api_token = os.environ.get('CRIPT_API_TOKEN')
storage_token = os.environ.get('CRIPT_STORAGE_TOKEN')
api = cript.API(
    host='https://api.criptapp.org',
    api_token=api_token, storage_token=storage_token
)
api.connect()

product_name = 'Some random name abcde'
print('Making project and collection...')
project_name = 'Project Test Shared Materials 123456'.format(product_name)
collection_name = 'Collection Shared Materials Test 123456'.format(product_name)
project = make_fetch_node(
    api, node_name=project_name
)
collection = make_fetch_node(
    api, node_name=collection_name, node_type=cript.Collection
)
project.collection += [collection]

material = make_fetch_node(
    api, product_name, node_type=cript.Material,
)
project.material += [material]

print('Saving {} project...'.format(product_name))
api.save(project)

print('Project saved fine... deleting...')
api.delete(project)

[c-heat16]

Changing the name of the material works sometimes, but other times it throws the error below, which I don't know what to make of? (the project/collection/material names are different than above, but created using the same process)

cript.api.exceptions.CRIPTAPISaveError: API responded to POST with 'http:400 'node' is a required property at path: properties/collection/items' data: {"node": ["Project"], "uid": "_:c855b0c5-ce7a-4f9d-8b05-0a7ec8e17f05", "uuid": "c855b0c5-ce7a-4f9d-8b05-0a7ec8e17f05", "name": "Project Test Shared Materials 12345678", "collection": [{"uuid": "435af0dd-0e6b-4aa6-afca-c532d340aa5b"}], "material": [{"node": ["Material"], "uid": "_:04e2d61c-bdd2-4397-aecb-ac489b6088d6", "uuid": "04e2d61c-bdd2-4397-aecb-ac489b6088d6", "name": "Benzoic Acid 1234", "names": ["Benzoic Acid 1234"]}]}

[nh916]

Changing the name of the material works sometimes, but other times it throws the error below, which I don't know what to make of? (the project/collection/material names are different than above, but created using the same process)

cript.api.exceptions.CRIPTAPISaveError: API responded to POST with 'http:400 'node' is a required property at path: properties/collection/items' data: {"node": ["Project"], "uid": "_:c855b0c5-ce7a-4f9d-8b05-0a7ec8e17f05", "uuid": "c855b0c5-ce7a-4f9d-8b05-0a7ec8e17f05", "name": "Project Test Shared Materials 12345678", "collection": [{"uuid": "435af0dd-0e6b-4aa6-afca-c532d340aa5b"}], "material": [{"node": ["Material"], "uid": "_:04e2d61c-bdd2-4397-aecb-ac489b6088d6", "uuid": "04e2d61c-bdd2-4397-aecb-ac489b6088d6", "name": "Benzoic Acid 1234", "names": ["Benzoic Acid 1234"]}]}

I've found that for these types of errors where it says 'http:400 'node' is a required property at path: properties/collection/items' the best thing I can do it to look through the full JSON and try to figure out what is missing or at an improper place and adding that in. If you have the full JSON for this I can try to look through it and locate the issue.

[nh916]

Hi @c-heat16, thank you for the detailed code and error log, that really helps. I tried to reproduce your code with my own script and I was able to successfully reproduce it. I think this is an API issue. I've created a ticket for the API and have notified our software engineer. The only temporary work around that I can think of at the moment is to use unique names for the project to avoid this issue, however, that could get messy very quickly. I think the permanent solution would be from the API to allow uploads with the same name after deletion. @brili might be able to provide a better answer or add more context to this.

My script to reproduce the error

import datetime
import os

import cript

with cript.API(host="https://lb-stage.mycriptapp.org/", api_token=os.getenv("CRIPT_TOKEN"),
               storage_token=os.getenv("CRIPT_STORAGE_TOKEN")) as api:
    # current time to keep the node names unique
    current_time = str(datetime.datetime.now())

    # create needed nodes
    my_project = cript.Project(name=f"my project name {current_time}")
    my_collection = cript.Collection(name=f"my collection name {current_time}")
    my_experiment = cript.Experiment(name=f"my experiment name {current_time}")
    my_reference = cript.Reference(type="journal_article", title=f"my title {current_time}")
    my_citation = cript.Citation(type="reference", reference=my_reference)
    my_material = cript.Material(
        name=f"my material name {current_time}", identifier=[{"names": [f"my material name {current_time}"]}]
    )

    # assemble the nodes
    my_project.collection = [my_collection]
    my_project.collection[0].experiment = [my_experiment]
    my_project.collection[0].experiment[0].citation = [my_citation]
    my_project.material = [my_material]

    api.save(project=my_project)

    api.delete(node=my_project)

    api.save(project=my_project)

raise CRIPTDuplicateNameError(response, json_data, exc) from exc
cript.api.exceptions.CRIPTDuplicateNameError: The name 'my project name 2023-11-06 15:32:40.698160' for your Project node is already present in CRIPT. Either choose a new name!