Add BurstCube TOO API endpoints

Add Validation to AstropyTime Add FOV check to BurstCubeTOO and other fixes Change healpix_order to healpix_scheme Compare ephem times in unix time as comparing freeform astropy time object can cause this to fail due to minute differences that create an out of bounds issue with the assertion in get_slice Fixes for modified_on/by Remove history table stuff for now Fix security for burstcube TOO Updates for mypy and cleanups Update import sorts Import sort Remove debug print statement Simplify database write/update Simplify database write/update Fix check for existing TOO Change BurstCubeTOO PUT to have the same arguments as POST, so we can use it to upload updated HEALPix Remove excess docstring from schema Reconfigure BurstCubeTOO to redo constraints check if PUT updates coordinates Change how uploads are done in the API Update TOO PUT schema Trap uploads of bad HEALPix files Fix bug Make schema and api return astropy native values Simplify requests.py Move to astropy native in schema. Clean up docstrings Clean up code reuse in BurstCubeTOO Json email selections (nasa-gcn#1977) Bump usehooks-ts from 2.15.0 to 2.15.1 Bumps [usehooks-ts](https://github.com/juliencrn/usehooks-ts) from 2.15.0 to 2.15.1. - [Release notes](https://github.com/juliencrn/usehooks-ts/releases) - [Commits](https://github.com/juliencrn/usehooks-ts/compare/[email protected]@2.15.1) --- updated-dependencies: - dependency-name: usehooks-ts dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Bump tiny-invariant from 1.3.1 to 1.3.3 Bumps [tiny-invariant](https://github.com/alexreardon/tiny-invariant) from 1.3.1 to 1.3.3. - [Release notes](https://github.com/alexreardon/tiny-invariant/releases) - [Commits](alexreardon/tiny-invariant@v1.3.1...v1.3.3) --- updated-dependencies: - dependency-name: tiny-invariant dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Support for reading gzipped fits files. Refactor reused code. Remove superfluous entries in app.arc Make BurstCubeTOO a dataclass to remove the init stuff Differentiate username and created by Back to username Remove a space in a comment. Compare jd instead of unix as it should always be consistent Put table into a property that can be set for pytest Don't hardcode TOO table name Clean up docstring Move table write into BurstCubeTOO Move BurstCubeTOOModel into schema.py Fix imports Remove types in docstrings Adds a confirmation alert (nasa-gcn#1957) * Adds a confirmation alert * Return intent and rename newItem to newCircular Better sentence text, adds heading Bump es5-ext from 0.10.61 to 0.10.63 Bumps [es5-ext](https://github.com/medikoo/es5-ext) from 0.10.61 to 0.10.63. - [Release notes](https://github.com/medikoo/es5-ext/releases) - [Changelog](https://github.com/medikoo/es5-ext/blob/main/CHANGELOG.md) - [Commits](medikoo/es5-ext@v0.10.61...v0.10.63) --- updated-dependencies: - dependency-name: es5-ext dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Announcement template (nasa-gcn#1958) Code of Conduct (nasa-gcn#1635) Docstring cleanups Fix use of old style Config in Pydantic model Add pytest to check CRUD operations on BurstCubeTOO Add check for SPACETRACK credentials Fix reject_reason Add old TOO rejection pytest Add test for double submission Add test for double submission Mock BurstCubeTLE so that we don't have to spam celestak or spacetrack Add pytest-mock requirement for testing Revert tle.py Mypy fixes Docstring fix Fix test time to a value that matches the test TLE Remove epoch for TLE Revert to Time.now() otherwise toos will get rejected a few days from now
jak574 · Feb 29, 2024 · 30ce71a · 30ce71a
1 parent e71a98c
commit 30ce71a
Show file tree

Hide file tree

Showing 14 changed files with 1,406 additions and 8 deletions.
diff --git a/app.arc b/app.arc
@@ -49,6 +49,9 @@ acrossapi_tle
   tle1 String
   tle2 String
 
+burstcube_too
+  id *String
+
 sessions
   _idx *String
   _ttl TTL

diff --git a/python/across_api/base/api.py b/python/across_api/base/api.py
@@ -4,10 +4,14 @@
 
 """
 Base API definitions for ACROSS API. This module is imported by all other API
-modules. Contains the FastAPI app definition.
+modules. Contains the FastAPI app definition and global depends definition.
 """
+from astropy.time import Time  # type: ignore[import]
+from datetime import datetime
+from typing import Annotated, Optional
+from fastapi import Depends, FastAPI, Path, Query
+import astropy.units as u  # type: ignore[import]
 
-from fastapi import FastAPI
 
 # FastAPI app definition
 app = FastAPI(
@@ -19,3 +23,167 @@
     },
     root_path="/labs/api/v1",
 )
+
+# FastAPI Depends definitions
+
+
+# Depends functions for FastAPI calls.
+async def optional_daterange(
+    begin: Annotated[
+        Optional[datetime],
+        Query(
+            description="Start time of period to be calculated.",
+            title="Begin",
+        ),
+    ] = None,
+    end: Annotated[
+        Optional[datetime],
+        Query(
+            description="Start time of period to be calculated.",
+            title="End",
+        ),
+    ] = None,
+) -> dict:
+    """
+    Helper function to convert begin and end to datetime objects.
+    """
+    if begin is None or end is None:
+        return {"begin": None, "end": None}
+    return {"begin": Time(begin), "end": Time(end)}
+
+
+OptionalDateRangeDep = Annotated[dict, Depends(optional_daterange)]
+
+
+# Depends functions for FastAPI calls.
+async def optional_length(
+    length: Annotated[
+        Optional[float],
+        Query(
+            description="Length of time (days).",
+            title="Length",
+        ),
+    ] = None,
+) -> Optional[u.Quantity]:
+    """
+    Helper function to convert begin and end to datetime objects.
+    """
+    if length is None:
+        return None
+    return length * u.day
+
+
+OptionalLengthDep = Annotated[dict, Depends(optional_length)]
+
+
+async def optional_limit(
+    limit: Annotated[
+        Optional[int],
+        Query(
+            ge=0,
+            title="Limit",
+            description="Maximum number of results to return.",
+        ),
+    ] = None,
+) -> Optional[int]:
+    return limit
+
+
+LimitDep = Annotated[Optional[int], Depends(optional_limit)]
+
+
+async def error_radius(
+    error_radius: Annotated[
+        Optional[float],
+        Query(
+            ge=0,
+            title="Error Radius",
+            description="Error radius in degrees.",
+        ),
+    ] = None,
+) -> Optional[float]:
+    if error_radius is None:
+        return None
+    return error_radius * u.deg
+
+
+ErrorRadiusDep = Annotated[float, Depends(error_radius)]
+
+
+async def exposure(
+    exposure: Annotated[
+        float,
+        Query(
+            ge=0,
+            title="Exposure",
+            description="Exposure time in seconds.",
+        ),
+    ] = 200,
+) -> u.Quantity:
+    return exposure * u.s
+
+
+ExposureDep = Annotated[float, Depends(exposure)]
+
+
+async def offset(
+    offset: Annotated[
+        float,
+        Query(
+            ge=-200,
+            le=200,
+            title="Offset",
+            description="Offset start of dump window from T0 by this amount (seconds).",
+        ),
+    ] = -50,
+) -> u.Quantity:
+    return offset * u.s
+
+
+OffsetDep = Annotated[float, Depends(offset)]
+
+
+IdDep = Annotated[str, Path(description="TOO ID string")]
+
+
+async def trigger_time(
+    trigger_time: Annotated[
+        datetime,
+        Query(
+            title="Trigger Time",
+            description="Time of trigger in UTC or ISO format.",
+        ),
+    ],
+) -> Optional[datetime]:
+    return Time(trigger_time)
+
+
+TriggerTimeDep = Annotated[datetime, Depends(trigger_time)]
+
+
+async def optional_ra_dec(
+    ra: Annotated[
+        Optional[float],
+        Query(
+            ge=0,
+            lt=360,
+            title="RA (J2000)",
+            description="Right Ascenscion in J2000 coordinates and units of decimal degrees.",
+        ),
+    ] = None,
+    dec: Annotated[
+        Optional[float],
+        Query(
+            ge=-90,
+            le=90,
+            title="Dec (J2000)",
+            description="Declination in J2000 coordinates in units of decimal degrees.",
+        ),
+    ] = None,
+) -> Optional[dict]:
+    if ra is None or dec is None:
+        return {"ra": None, "dec": None}
+    return {"ra": ra * u.deg, "dec": dec * u.deg}
+
+
+OptionalRaDecDep = Annotated[dict, Depends(optional_ra_dec)]
diff --git a/python/across_api/base/constraints.py b/python/across_api/base/constraints.py
@@ -41,7 +41,7 @@ def get_slice(time: Time, ephem: EphemBase) -> slice:
     else:
         # Check that the time range is within the ephemeris range, as above.
         assert (
-            time[0] >= ephem.begin and time[-1] <= ephem.end
+            time[0].jd >= ephem.begin.jd and time[-1].jd <= ephem.end.jd
         ), "Time outside of ephemeris of range"
 
         # Find the indices for the start and end of the time range and return a

diff --git a/python/across_api/base/database.py b/python/across_api/base/database.py
@@ -0,0 +1,14 @@
+from typing import Any
+import arc  # type: ignore[import]
+import boto3  # type: ignore[import]
+import os
+
+
+def dynamodb_table(tablename) -> Any:
+    """If running in Architect, return tables.table, else return boto3 dynamodb
+    table. This enables the use of moto to mock the dynamodb table in tests."""
+    if os.environ.get("ARC_ENV") is not None:
+        return arc.tables.table(tablename)
+    else:
+        session = boto3.Session()
+        return session.resource("dynamodb", region_name="us-east-1").Table(tablename)