13 |
20 |
14 |
15 |
16 |
17 |
19 | {children}
18 |
8 |
9 | 
10 |
11 |
12 | 
13 |
14 |
22 | `
23 |
24 | setupCounter(document.querySelector('#counter'))
25 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/ui/textarea.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react'
2 |
3 | import { cn } from '@/lib/utils/cn'
4 |
5 | export type TextareaProps = React.TextareaHTMLAttributesHello Nitric!
15 |
16 |
17 |
18 | 19 | Click on the Vite logo to learn more 20 |
21 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
22 | `
23 |
24 | setupCounter(document.querySelector('#counter'))
25 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/ui/input.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react'
2 |
3 | import { cn } from '@/lib/utils/cn'
4 |
5 | const Input = React.forwardRefHello Nitric Docs Test!
15 |
16 |
17 |
18 | 19 | Click on the Vite logo to learn more 20 |
21 |
16 | {endpoints.map((endpoint) => (
17 |
34 | )
35 | }
36 |
37 | export default APIRoutesList
38 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/ui/checkbox.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react'
2 | import * as CheckboxPrimitive from '@radix-ui/react-checkbox'
3 | import { Check } from 'lucide-react'
4 |
5 | import { cn } from '@/lib/utils/cn'
6 |
7 | const Checkbox = React.forwardRef<
8 | React.ElementRef
18 |
32 | ))}
33 |
19 |
21 |
22 |
28 | {endpoint.path}
29 |
30 |
31 |
22 |
30 | )
31 | }
32 |
33 | export default FileUpload
34 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/lib/hooks/use-secret.ts:
--------------------------------------------------------------------------------
1 | import { useCallback } from 'react'
2 | import useSWR from 'swr'
3 | import { fetcher } from './fetcher'
4 | import type { SecretVersion } from '@/types'
5 | import { SECRETS_API } from '../constants'
6 |
7 | export const useSecret = (secretName?: string) => {
8 | const { data, mutate } = useSWR25 | {isDragActive 26 | ? `Drop the ${multiple ? 'files' : 'file'} here ...` 27 | : `Drag or click to add ${multiple ? 'files' : 'file'}.`} 28 |
29 |
30 | Events:
31 | {Object.keys(data.resource.targets).join(', ')}
32 |
33 |
34 | ) : null}
35 |
36 | ),
37 | }}
38 | />
39 | )
40 | }
41 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/architecture/nodes/WebsitesNode.tsx:
--------------------------------------------------------------------------------
1 | import { type ComponentType } from 'react'
2 |
3 | import type { Website } from '@/types'
4 | import type { NodeProps } from 'reactflow'
5 | import NodeBase, { type NodeBaseData } from './NodeBase'
6 | import SitesList from '@/components/websites/SitesList'
7 |
8 | export type WebsitesNodeData = NodeBaseData
26 |
29 |
44 | )
45 | }
46 |
47 | export default TextField
48 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/lib/hooks/use-logs.ts:
--------------------------------------------------------------------------------
1 | import { useCallback } from 'react'
2 | import useSWR from 'swr'
3 | import { fetcher } from './fetcher'
4 | import type { LogEntry } from '@/types'
5 | import { LOGS_API } from '../constants'
6 |
7 | interface LogQueryParams {
8 | origin?: string
9 | timeline?: string
10 | level?: LogEntry['level']
11 | search?: string
12 | }
13 |
14 | const buildQueryString = (params: LogQueryParams) => {
15 | const searchParams = new URLSearchParams()
16 | Object.entries(params).forEach(([key, value]) => {
17 | if (value !== undefined && value !== null) {
18 | searchParams.append(key, String(value))
19 | }
20 | })
21 | return searchParams.toString()
22 | }
23 |
24 | export const useLogs = (query: LogQueryParams) => {
25 | // Build query string dynamically
26 | const queryString = buildQueryString(query)
27 |
28 | // build query string
29 | const { data, mutate } = useSWR
32 | {Icon && (
33 |
43 |
34 |
35 |
36 | )}
37 |
42 |
37 |
38 | {title}
39 |
40 | {headerSiblings}
41 |
42 | {description &&
40 |
50 | )
51 |
52 | return showLoader || !conditionToShow ? (
53 | Loader
54 | ) : (
55 |
41 |
48 | Loading...
49 |
12 | Root Site:
13 |
50 | )
51 | }
52 |
53 | export default SitesList
54 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/cypress/e2e/websites.cy.ts:
--------------------------------------------------------------------------------
1 | describe('Websites Spec', () => {
2 | beforeEach(() => {
3 | cy.viewport('macbook-16')
4 | })
5 |
6 | const expectedWebsites = ['vite-website', 'docs-website']
7 |
8 | it('should retrieve correct websites in list', () => {
9 | cy.visit('/websites')
10 | cy.get('h2').should('contain.text', 'docs-website')
11 |
12 | expectedWebsites.forEach((id) => {
13 | cy.get(`[data-rct-item-id="${id}"]`).should('exist')
14 | })
15 | })
16 |
17 | expectedWebsites.forEach((id) => {
18 | it(`should render website ${id}`, () => {
19 | cy.visit('/websites')
20 | cy.get(`[data-rct-item-id="${id}"]`).click()
21 | cy.get('h2').should('contain.text', id)
22 |
23 | let originMap = {}
24 |
25 | if (Cypress.env('NITRIC_TEST_TYPE') === 'run') {
26 | originMap = {
27 | 'vite-website': 'http://localhost:5000',
28 | 'docs-website': 'http://localhost:5000',
29 | }
30 | } else {
31 | originMap = {
32 | 'vite-website': 'http://localhost:5000',
33 | 'docs-website': 'http://localhost:5001',
34 | }
35 | }
36 |
37 | const pathMap = {
38 | 'vite-website': '/',
39 | 'docs-website': '/docs',
40 | }
41 |
42 | // check iframe url
43 | cy.get('iframe').should('have.attr', 'src', originMap[id] + pathMap[id])
44 |
45 | cy.visit(originMap[id] + pathMap[id])
46 |
47 | const titleMap = {
48 | 'vite-website': 'Hello Nitric!',
49 | 'docs-website': 'Hello Nitric Docs Test!',
50 | }
51 |
52 | const title = titleMap[id]
53 |
54 | cy.origin(originMap[id], { args: { title } }, ({ title }) => {
55 | cy.get('h1').should('have.text', title)
56 | })
57 | })
58 | })
59 | })
60 |
--------------------------------------------------------------------------------
/pkg/env/env.go:
--------------------------------------------------------------------------------
1 | // Copyright Nitric Pty Ltd.
2 | //
3 | // SPDX-License-Identifier: Apache-2.0
4 | //
5 | // Licensed under the Apache License, Version 2.0 (the "License");
6 | // you may not use this file except in compliance with the License.
7 | // You may obtain a copy of the License at:
8 | //
9 | // http://www.apache.org/licenses/LICENSE-2.0
10 | //
11 | // Unless required by applicable law or agreed to in writing, software
12 | // distributed under the License is distributed on an "AS IS" BASIS,
13 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | // See the License for the specific language governing permissions and
15 | // limitations under the License.
16 |
17 | package env
18 |
19 | import (
20 | "os"
21 |
22 | "github.com/joho/godotenv"
23 | )
24 |
25 | var defaultEnv = ".env"
26 |
27 | func ReadEnv(filePath string) (map[string]string, error) {
28 | file, err := os.OpenFile(filePath, os.O_RDONLY, 0o666)
29 | if err != nil {
30 | return nil, err
31 | }
32 |
33 | return godotenv.Parse(file)
34 | }
35 |
36 | func ReadLocalEnv(additionalFilePaths ...string) (map[string]string, error) {
37 | envVariables, err := ReadEnv(defaultEnv)
38 | if err != nil && !os.IsNotExist(err) {
39 | return nil, err
40 | }
41 |
42 | if envVariables == nil {
43 | envVariables = map[string]string{}
44 | }
45 |
46 | for _, filePath := range additionalFilePaths {
47 | additionalEnvVariables, err := ReadEnv(filePath)
48 | if err != nil {
49 | return nil, err
50 | }
51 |
52 | for key, value := range additionalEnvVariables {
53 | envVariables[key] = value
54 | }
55 | }
56 |
57 | return envVariables, nil
58 | }
59 |
60 | func LoadLocalEnv(additionalFilePaths ...string) error {
61 | paths := append(additionalFilePaths, defaultEnv)
62 | return godotenv.Load(paths...)
63 | }
64 |
--------------------------------------------------------------------------------
/hack/modversion/main.go:
--------------------------------------------------------------------------------
1 | // Copyright Nitric Pty Ltd.
2 | //
3 | // SPDX-License-Identifier: Apache-2.0
4 | //
5 | // Licensed under the Apache License, Version 2.0 (the "License");
6 | // you may not use this file except in compliance with the License.
7 | // You may obtain a copy of the License at:
8 | //
9 | // http://www.apache.org/licenses/LICENSE-2.0
10 | //
11 | // Unless required by applicable law or agreed to in writing, software
12 | // distributed under the License is distributed on an "AS IS" BASIS,
13 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | // See the License for the specific language governing permissions and
15 | // limitations under the License.
16 |
17 | package main
18 |
19 | import (
20 | "bufio"
21 | "flag"
22 | "fmt"
23 | "io"
24 | "os"
25 | "strings"
26 |
27 | "github.com/hashicorp/go-version"
28 | )
29 |
30 | func main() {
31 | inpath := flag.Bool("inpath", false, "")
32 |
33 | flag.Parse()
34 |
35 | prefix := flag.Arg(0)
36 |
37 | file, err := os.Open("go.sum")
38 | if err != nil {
39 | panic(err)
40 | }
41 | defer file.Close()
42 |
43 | reader := bufio.NewReader(file)
44 |
45 | for {
46 | line, _, err := reader.ReadLine()
47 | if err != nil {
48 | if err == io.EOF {
49 | break
50 | }
51 |
52 | panic(err)
53 | }
54 |
55 | words := strings.Split(string(line), " ")
56 |
57 | if !strings.HasPrefix(words[0], prefix) {
58 | continue
59 | }
60 |
61 | if *inpath {
62 | for _, seg := range strings.Split(strings.TrimPrefix(words[0], prefix), "/") {
63 | v, err := version.NewSemver(seg)
64 | if err != nil {
65 | continue
66 | }
67 |
68 | fmt.Println(v.Original())
69 |
70 | return
71 | }
72 | } else if len(words) == 3 {
73 | fmt.Print(words[1])
74 |
75 | return
76 | }
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/layout/AppLayout/NavigationItem.tsx:
--------------------------------------------------------------------------------
1 | import { cn } from '@/lib/utils'
2 | import React from 'react'
3 |
4 | export interface NavigationItemProps {
5 | name: string
6 | href: string
7 | icon: React.ForwardRefExoticComponent<
8 | Omit
14 |
25 | {subsites.length > 0 ? (
26 | <>
27 | Subsites:
28 |
15 |
21 | {rootSite.url}
22 |
23 |
24 |
29 | {subsites.map((website) => (
30 |
47 |
48 | ) : null}
49 |
34 |
45 | ))}
46 |
35 |
41 | {website.url}
42 |
43 |
44 |
30 | Cron:
31 | {data.resource.expression}
32 |
33 |
34 | Description:
35 |
36 | {cronstrue.toString(data.resource.expression, {
37 | verbose: true,
38 | })}
39 |
40 |
41 |
42 | ) : (
43 |
44 | Rate:
45 | Every {data.resource.rate}
46 |
47 | )}
48 |
49 | ),
50 | }}
51 | />
52 | )
53 | }
54 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/ui/scroll-area.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react'
2 | import * as ScrollAreaPrimitive from '@radix-ui/react-scroll-area'
3 |
4 | import { cn } from '@/lib/utils/cn'
5 |
6 | const ScrollArea = React.forwardRef<
7 | React.ElementRef
4 |
5 | 
6 |
7 |
10 | CLI for building and deploying nitric apps 11 |
12 | 13 | ## 🚀 Project Structure 14 | 15 | Inside the dashboard project, you'll see the following folders and files: 16 | 17 | ``` 18 | / 19 | ├── public/ 20 | │ └── favicon.ico 21 | ├── src/ 22 | │ ├── components/ 23 | │ ├── layouts/ 24 | | ├── lib/ 25 | │ └── pages/ 26 | │ └── index.astro 27 | └── package.json 28 | ``` 29 | 30 | Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. 31 | 32 | There's nothing special about `src/components/`, but that's where we like to put any Astro or React components. 33 | 34 | Any static assets, like images, can be placed in the `public/` directory. 35 | 36 | ## 🧞 Commands 37 | 38 | All commands are run from the root of the project, from a terminal: 39 | 40 | | Command | Action | 41 | | :------------------ | :-------------------------------------------------------- | 42 | | `yarn install` | Installs dependencies | 43 | | `yarn dev` | Starts local dev server at `localhost:3000` | 44 | | `yarn build` | Build the production dashboard to `../pkg/dashboard/dist` | 45 | | `yarn preview` | Preview your build locally, before deploying | 46 | | `yarn cypress:open` | Open Cypress for e2e testing | 47 | | `yarn astro ...` | Run CLI commands like `astro add`, `astro check` | 48 | | `yarn astro --help` | Get help using the Astro CLI | 49 | 50 | ## Need help with Nitric? 51 | 52 | Feel free to check out the [Nitric documentation](https://nitric.io/docs) or jump on our [Discord Server](https://nitric.io/chat). 53 | -------------------------------------------------------------------------------- /.github/workflows/dashboard-run-test.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Dashboard Tests with nitric run 3 | 4 | on: 5 | push: 6 | branches: 7 | - main 8 | - develop 9 | pull_request: 10 | 11 | concurrency: 12 | group: ci-dash-run-tests-${{ github.ref_name }} 13 | cancel-in-progress: true 14 | 15 | env: 16 | GOPROXY: https://proxy.golang.org 17 | FATHOM_SITE: FAKE1234 18 | 19 | jobs: 20 | nitric-dashboard: 21 | runs-on: ubuntu-latest 22 | steps: 23 | - name: Checkout 24 | uses: actions/checkout@v3 25 | with: 26 | path: cli 27 | 28 | - uses: actions/setup-node@v4 29 | with: 30 | node-version: 22 31 | 32 | - name: Setup Go 33 | uses: actions/setup-go@v3 34 | with: 35 | go-version: 1.22 36 | 37 | - name: Build Nitric 38 | run: | 39 | cd ${{ github.workspace }}/cli 40 | make build 41 | mv bin/nitric $(go env GOPATH)/bin/nitric 42 | 43 | - name: Run nitric run with test-app in the background 44 | run: | 45 | cd ${{ github.workspace }}/cli/pkg/dashboard/frontend/test-app 46 | yarn install 47 | yarn install:websites 48 | nitric run --ci & 49 | sleep 25 50 | 51 | - name: Run Tests 52 | uses: cypress-io/github-action@v5 53 | env: 54 | CYPRESS_NITRIC_TEST_TYPE: "run" 55 | with: 56 | install: false 57 | wait-on: "http://localhost:49152" 58 | # wait for 3 minutes for the server to respond 59 | wait-on-timeout: 180 60 | working-directory: cli/pkg/dashboard/frontend 61 | browser: chrome 62 | 63 | - uses: actions/upload-artifact@v4 64 | if: failure() 65 | with: 66 | name: cypress-screenshots 67 | path: cli/pkg/dashboard/frontend/cypress/screenshots 68 | 69 | - uses: actions/upload-artifact@v4 70 | if: failure() 71 | with: 72 | name: cypress-videos 73 | path: cli/pkg/dashboard/frontend/cypress/videos 74 | -------------------------------------------------------------------------------- /pkg/view/tui/printer.go: -------------------------------------------------------------------------------- 1 | // Copyright Nitric Pty Ltd. 2 | // 3 | // SPDX-License-Identifier: Apache-2.0 4 | // 5 | // Licensed under the Apache License, Version 2.0 (the "License"); 6 | // you may not use this file except in compliance with the License. 7 | // You may obtain a copy of the License at: 8 | // 9 | // http://www.apache.org/licenses/LICENSE-2.0 10 | // 11 | // Unless required by applicable law or agreed to in writing, software 12 | // distributed under the License is distributed on an "AS IS" BASIS, 13 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | // See the License for the specific language governing permissions and 15 | // limitations under the License. 16 | 17 | package tui 18 | 19 | import ( 20 | "fmt" 21 | "unicode/utf8" 22 | 23 | "github.com/charmbracelet/lipgloss" 24 | 25 | "github.com/nitrictech/cli/pkg/view/tui/components/view" 26 | ) 27 | 28 | var ( 29 | Debug = TagPrinter{ 30 | Prefix: addPrefix("debug", Colors.White, Colors.TextMuted), 31 | } 32 | Error = TagPrinter{ 33 | Prefix: addPrefix("error", Colors.White, Colors.Red), 34 | } 35 | Info = TagPrinter{ 36 | Prefix: addPrefix("info", Colors.White, Colors.TextMuted), 37 | } 38 | Warning = TagPrinter{ 39 | Prefix: addPrefix("warning", Colors.Black, Colors.Yellow), 40 | } 41 | 42 | width = 0 43 | ) 44 | 45 | type TagPrinter struct { 46 | Prefix string 47 | } 48 | 49 | func (t *TagPrinter) Println(message string) { 50 | fmt.Println(t.Prefix, message) 51 | } 52 | 53 | func (t *TagPrinter) Printfln(message string, a ...interface{}) { 54 | fmt.Println(t.Prefix, fmt.Sprintf(message, a...)) 55 | } 56 | 57 | func addPrefix(text string, foreground lipgloss.CompleteAdaptiveColor, background lipgloss.CompleteAdaptiveColor) string { 58 | if utf8.RuneCountInString(text)+2 > width { 59 | width = utf8.RuneCountInString(text) + 2 60 | } 61 | 62 | tagStyle := lipgloss.NewStyle().Width(width).Align(lipgloss.Center).Foreground(foreground).Background(background) 63 | 64 | f := view.NewFragment(text).WithStyle(tagStyle) 65 | 66 | return f.Render() 67 | } 68 | -------------------------------------------------------------------------------- /pkg/dashboard/frontend/src/components/events/EventsHistory.tsx: -------------------------------------------------------------------------------- 1 | import type { 2 | EventHistoryItem, 3 | EventResource, 4 | TopicHistoryItem, 5 | } from '../../types' 6 | import { formatJSON } from '@/lib/utils' 7 | import CodeEditor from '../apis/CodeEditor' 8 | import HistoryAccordion from '../shared/HistoryAccordion' 9 | 10 | interface Props { 11 | history: EventHistoryItem[] 12 | selectedWorker: EventResource 13 | workerType: 'schedules' | 'topics' | 'jobs' 14 | } 15 | 16 | const EventsHistory: React.FCThere is no history.
28 | } 29 | 30 | return ( 31 |
32 | {
34 | let payload = ''
35 |
36 | if (workerType === 'topics' || workerType === 'jobs') {
37 | payload = (h.event as TopicHistoryItem['event']).payload
38 | }
39 |
40 | const formattedPayload = payload ? formatJSON(payload) : ''
41 |
42 | return {
43 | label: h.event.name,
44 | time: h.time,
45 | success: Boolean(h.event.success),
46 | content: formattedPayload ? (
47 |
63 | )
64 | }
65 |
66 | export default EventsHistory
67 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/cypress/e2e/architecture.cy.ts:
--------------------------------------------------------------------------------
1 | const expectedNodes = [
2 | 'first-api',
3 | 'second-api',
4 | 'socket',
5 | 'socket-2',
6 | 'socket-3',
7 | 'process-tests',
8 | 'process-tests-2',
9 | 'test-collection',
10 | 'connections',
11 | 'test-bucket',
12 | 'subscribe-tests',
13 | 'subscribe-tests-2',
14 | ':',
15 | 'my-db',
16 | 'my-second-db',
17 | 'services/my-test-service.ts',
18 | 'services/my-test-db.ts',
19 | 'services/my-test-secret.ts',
20 | 'my-first-secret',
21 | 'my-second-secret',
22 | 'CDN',
23 | ]
24 |
25 | describe('Architecture Spec', () => {
26 | beforeEach(() => {
27 | cy.viewport('macbook-16')
28 | cy.visit('/architecture')
29 | })
30 |
31 | it('should retrieve correct arch nodes', () => {
32 | cy.wait(500)
33 |
34 | expectedNodes.forEach((content) => {
35 | cy.log(`Checking that node: ${content} exists`)
36 | expect(cy.contains('.react-flow__node', content)).to.exist
37 | })
38 | })
39 |
40 | it('should have correct routes drawer content', () => {
41 | const expected = [
42 | [
43 | 'edge-label-e-first-api-services/my-test-service.ts',
44 | 'DELETE/all-methodsGET/all-methodsOPTIONS/all-methodsPATCH/all-methodsPOST/all-methodsPUT/all-methodsGET/header-testPOST/json-testGET/path-test/{name}GET/query-testGET/schedule-countGET/topic-count',
45 | ],
46 | [
47 | 'edge-label-e-second-api-services/my-test-service.ts',
48 | 'GET/content-type-binaryGET/content-type-cssGET/content-type-htmlGET/content-type-imageGET/content-type-xmlDELETE/image-from-bucketGET/image-from-bucketPUT/image-from-bucketPUT/very-nested-files',
49 | ],
50 | [
51 | 'edge-label-e-my-secret-api-services/my-test-secret.ts',
52 | 'GET/getPOST/setPOST/set-binary',
53 | ],
54 | ['edge-label-e-my-db-api-services/my-test-db.ts', 'GET/get'],
55 | ]
56 |
57 | expected.forEach(([edge, routes]) => {
58 | cy.getTestEl(edge).click({
59 | force: true,
60 | })
61 |
62 | cy.getTestEl('api-routes-list').should('have.text', routes)
63 | })
64 | })
65 | })
66 |
--------------------------------------------------------------------------------
/pkg/dashboard/frontend/src/components/ui/tabs.tsx:
--------------------------------------------------------------------------------
1 | import * as React from 'react'
2 | import * as TabsPrimitive from '@radix-ui/react-tabs'
3 |
4 | import { cn } from '@/lib/utils/cn'
5 |
6 | const Tabs = TabsPrimitive.Root
7 |
8 | const TabsList = React.forwardRef<
9 | React.ElementRef
48 |
58 | ) : undefined,
59 | }
60 | })}
61 | />
62 |
49 |
57 | Payload
50 |