Skip to content

Commit eec5001

Browse files
author
Michael Durling
authored
New service to record activity for auditing (#1029)
* New service to record activity for auditing * Fix exception message * Don't retry attempts to record activity * Use a single logger instance * Update container image version * Make recording activity more failsafe
1 parent 35c59de commit eec5001

29 files changed

+986
-39
lines changed

‎.changeset/pink-candles-cough.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@container-images/mds-activity-service": patch
3+
"@mds-core/mds-activity-service": patch
4+
---
5+
6+
Add new service for recording activity for auditing purposes

‎.jest/configurePorts.ts

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import findPort from 'find-port-free-sync'
77
Object.assign(
88
process.env,
99
...[
10+
'ACTIVITY_SERVICE_REPL_PORT',
11+
'ACTIVITY_SERVICE_RPC_PORT',
1012
'AGENCY_API_HTTP_PORT',
1113
'ATTACHMENT_SERVICE_REPL_PORT',
1214
'ATTACHMENT_SERVICE_RPC_PORT',

‎.mocharc.json

-7
This file was deleted.

‎container-images/mds-activity-service/Dockerfile

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
FROM node:16.14.2-alpine3.15
2+
3+
RUN apk add --no-cache tini rlwrap
4+
5+
RUN mkdir /mds
6+
7+
COPY docker_package.json /mds/package.json
8+
9+
WORKDIR /mds
10+
11+
RUN npm install
12+
13+
COPY dist/* .
14+
15+
ENTRYPOINT ["/sbin/tini", "node", "--require", "dd-trace/init", "--no-deprecation", "--experimental-repl-await", "server.js"]

‎container-images/mds-activity-service/package.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "@container-images/mds-activity-service",
3+
"version": "0.1.0",
4+
"private": true,
5+
"description": "Docker Image for MDS Activity Service",
6+
"keywords": [
7+
"mds"
8+
],
9+
"license": "Apache-2.0",
10+
"author": "City of Los Angeles",
11+
"files": [
12+
"dist/"
13+
],
14+
"scripts": {
15+
"bundle": "pnpm bundle:production",
16+
"bundle:development": "webpack --mode=development --env npm_package_name=${npm_package_name} --env npm_package_version=${npm_package_version}",
17+
"bundle:production": "webpack --mode=production --env npm_package_name=${npm_package_name} --env npm_package_version=${npm_package_version}",
18+
"image": "pnpm image:production",
19+
"image:development": "pnpm bundle:development && ../../bin/build-helper buildImage mds-activity-service:latest",
20+
"image:production": "pnpm bundle:production && ../../bin/build-helper buildImage mds-activity-service:production"
21+
},
22+
"dependencies": {
23+
"@mds-core/mds-activity-service": "workspace:0.1.0",
24+
"@mds-core/mds-webpack-config": "workspace:0.1.15",
25+
"dd-trace": "2.6.0",
26+
"express": "4.18.1",
27+
"pg": "8.7.3",
28+
"pino": "7.11.0"
29+
}
30+
}

‎container-images/mds-activity-service/webpack.config.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import webpack from '@mds-core/mds-webpack-config'
2+
3+
export default webpack.Bundle('../../packages/mds-activity-service/server').UsingDefaultConfig()

‎env.jenkins

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
export ACTIVITY_SERVICE_REPL_PORT=$(randport)
2+
export ACTIVITY_SERVICE_RPC_PORT=$(randport)
3+
14
export AGENCY_API_HTTP_PORT=$(randport)
25

36
export ATTACHMENT_SERVICE_REPL_PORT=$(randport)

‎packages/mds-activity-service/@types/index.ts

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/**
2+
* Copyright 2022 City of Los Angeles
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import type { DomainModelCreate } from '@mds-core/mds-repository'
18+
import type { RpcAuthorizedRequestContext, RpcServiceDefinition } from '@mds-core/mds-rpc-common'
19+
import { RpcRoute } from '@mds-core/mds-rpc-common'
20+
import type { Nullable } from '@mds-core/mds-types'
21+
22+
export interface ActivityDomainModel {
23+
category: string
24+
type: string
25+
description: string
26+
details: Nullable<{}>
27+
}
28+
29+
export type ActivityDomainCreateModel = DomainModelCreate<ActivityDomainModel>
30+
31+
export type GetActivityOptions = Partial<{
32+
limit: number
33+
}>
34+
35+
export type GetActivityResults = {
36+
activity: Array<ActivityDomainModel>
37+
cursor: { next: Nullable<string>; prev: Nullable<string> }
38+
}
39+
40+
export interface ActivityService {
41+
recordActivity: (
42+
category: ActivityDomainCreateModel['category'],
43+
type: ActivityDomainCreateModel['type'],
44+
description: ActivityDomainCreateModel['description'],
45+
details?: ActivityDomainCreateModel['details']
46+
) => void
47+
getActivity: (options?: GetActivityOptions) => GetActivityResults
48+
}
49+
50+
export const ActivityServiceDefinition: RpcServiceDefinition<ActivityService> = {
51+
recordActivity: RpcRoute<ActivityService['recordActivity']>(),
52+
getActivity: RpcRoute<ActivityService['getActivity']>()
53+
}
54+
55+
export type ActivityServiceRequestContext = RpcAuthorizedRequestContext

‎packages/mds-activity-service/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/mds-activity-service/client/index.ts

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
/**
2+
* Copyright 2022 City of Los Angeles
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import type { RpcRequestOptions } from '@mds-core/mds-rpc-common'
18+
import { RpcClient, RpcRequest } from '@mds-core/mds-rpc-common'
19+
import type { ServiceClient } from '@mds-core/mds-service-helpers'
20+
import type { ActivityService, ActivityServiceRequestContext } from '../@types'
21+
import { ActivityServiceDefinition } from '../@types'
22+
23+
// What the API layer, and any other clients, will invoke.
24+
export const ActivityServiceClientFactory = (
25+
context: ActivityServiceRequestContext,
26+
options: RpcRequestOptions = {}
27+
): ServiceClient<ActivityService> => {
28+
const ActivityServiceRpcClient = RpcClient(ActivityServiceDefinition, {
29+
context,
30+
host: process.env.ACTIVITY_SERVICE_RPC_HOST,
31+
port: process.env.ACTIVITY_SERVICE_RPC_PORT
32+
})
33+
34+
return {
35+
recordActivity: async (...args) => {
36+
try {
37+
await RpcRequest({ retries: false, ...options }, ActivityServiceRpcClient.recordActivity, args)
38+
} catch {}
39+
},
40+
getActivity: (...args) => RpcRequest(options, ActivityServiceRpcClient.getActivity, args)
41+
}
42+
}
43+
44+
export const ActivityServiceClient = ActivityServiceClientFactory({ token_type: 'None' })

0 commit comments

Comments
 (0)